[configuration] Specify YAML schema that configuration files should follow #3973
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @open-telemetry/configuration-maintainers |
jack-berg
reviewed
Apr 2, 2024
1 task
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
jack-berg
approved these changes
Apr 25, 2024
|
@MrAlias and maybe @carlosalberto take a look when you can. I think this should be ready with an additional approval. |
carlosalberto
approved these changes
May 7, 2024
pellared
reviewed
May 7, 2024
Co-authored-by: Robert Pająk <[email protected]>
carlosalberto
pushed a commit
to carlosalberto/opentelemetry-specification
that referenced
this pull request
Oct 31, 2024
…ollow (open-telemetry#3973) Fixes open-telemetry#3962 ## Changes Specifies the YAML schema to follow. A schema is a set of YAML tags (i.e. types) and a way to assign types. YAML 1.2 recommends the 'Core schema': the types are those of JSON. Scalars are resolved as one would expect, see [here](https://yaml.org/spec/1.2.2/#103-core-schema) for the details. One important difference with the way that YAML 1.1 used to work is that integer scalars starting with a `0` are interpreted as being written in decimal notation; e.g. `0123` parses to the integer 123 instead of the integer 83 (you can still use octal notation in YAML 1.2 by using `0o123`). Some YAML parsers deviate from the core schema in how this works, for example, both of the more commonly used YAML parsing libraries in Golang parse `0123` as 83 ([go-yaml/yaml](https://github.com/go-yaml/yaml?tab=readme-ov-file#compatibility) and [goccy/go-yaml](https://github.com/goccy/go-yaml/blob/4653a1bb5c0047bb37280ac341e2f091cb44352f/ast/ast.go#L326)). **This may make it a bit difficult to strictly follow this requirement in some languages**. For non-trivial changes, follow the [change proposal process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change). * [x] Related issues open-telemetry#3962, part of open-telemetry#3963 --------- Co-authored-by: Robert Pająk <[email protected]> Co-authored-by: jack-berg <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3962
Changes
Specifies the YAML schema to follow. A schema is a set of YAML tags (i.e. types) and a way to assign types.
YAML 1.2 recommends the 'Core schema': the types are those of JSON. Scalars are resolved as one would expect, see here for the details.
One important difference with the way that YAML 1.1 used to work is that integer scalars starting with a
0are interpreted as being written in decimal notation; e.g.0123parses to the integer 123 instead of the integer 83 (you can still use octal notation in YAML 1.2 by using0o123). Some YAML parsers deviate from the core schema in how this works, for example, both of the more commonly used YAML parsing libraries in Golang parse0123as 83 (go-yaml/yaml and goccy/go-yaml). This may make it a bit difficult to strictly follow this requirement in some languages.For non-trivial changes, follow the change proposal process.